-*- mode: org; coding: utf-8; -*-

#+TITLE: Readme
#+AUTHOR: Zelphir Kaltstahl
#+EMAIL: zelphirkaltstahl@posteo.de
#+STARTUP: content indent align inlineimages hideblocks entitiesplain nologdone nologreschedule nologredeadline nologrefile
#+TODO: TODO INPROGRESS | DONE
#+DATE: [2022-07-02 Sa]
#+LANGUAGE: English
#+PRIORITIES: A E E

* About
:PROPERTIES:
:custom_id: about
:END:

guile-fslib is a library, which contains procedures for working with
filenames. It simplifies common tasks like splitting, joining and
getting the file extension of a filename.

* Supported operations
:PROPERTIES:
:custom_id: supported-operations
:END:

+ joining of parts of a filename
+ splitting a filename into its parts
+ getting the file extension part of a filename
+ checking if a filename is a sub-filename of another filename
+ getting the absolute filename of a filename
+ checking if a filename is an absolute filename

* Testing
:PROPERTIES:
:custom_id: testing
:END:

Tests can be invoked from the root directory of the project as follows:

#+begin_src shell
guile -L . test/<test-file>
#+end_src
